/*
 * Tai-e: A Static Analysis Framework for Java
 *
 * Copyright (C) 2022 Tian Tan <tiantan@nju.edu.cn>
 * Copyright (C) 2022 Yue Li <yueli@nju.edu.cn>
 *
 * This file is part of Tai-e.
 *
 * Tai-e is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 *
 * Tai-e is distributed in the hope that it will be useful,but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
 * Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Tai-e. If not, see <https://www.gnu.org/licenses/>.
 */

package pascal.taie.analysis;

import pascal.taie.config.AnalysisConfig;

/**
 * Abstract base class for all whole-program analyses.
 *
 * @param <R> result type
 */
public abstract class ProgramAnalysis<R> extends Analysis {

    protected ProgramAnalysis(AnalysisConfig config) {
        super(config);
    }

    /**
     * Runs this analysis for the whole program.
     * If the result is not used by following analyses, then this method
     * should return {@code null}.
     *
     * @return the analysis result for the whole program.
     * The result will be stored in {@link pascal.taie.World}.
     */
    public abstract R analyze();
}
